/* 
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.  
 */
package erwiki.plugins;

import java.util.Map;

import org.apache.commons.lang3.BooleanUtils;
import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.PluginException;
import erwiki.api.plugin.WikiPlugin;

/**
 * Плагин ErWiki. Предоставляет специфичный счетчик для страницы. Он сбрасывается каждый раз при
 * отображении страницы, поэтому его невозможно использовать в качестве счетчика посещений.</br>
 * Сохраняет в WikiContext переменную под названием "counter", с добавленным суффиксом из
 * опционально заданной переменной "name".</br>
 * Например: если переменная 'name' содержит "thispage", то имя контекстной переменной будет
 * "counter-thispage".
 * <p>
 * Параметры плагина:
 * <ul>
 * <li><b>name</b> - Название счетчика. Необязательный параметр.</li>
 * <li><b>increment</b> - Число приращения может быть отрицательным значением, по умолчанию =1.
 * Необязательный параметр.</li>
 * <li><b>showResult</b> - Указывает, должно ли значение счетчика отображаться на странице. По
 * умолчанию установлено значение true. Необязательный параметр.</li>
 * </ul>
 */
public class CounterPlugin implements WikiPlugin {

	// private static Logger log = Logger.getLogger(CounterPlugin.class);

	/** Имя параметра для настройки <i>name</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_NAME = "name";

	/** Имя параметра для настройки <i>increment</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_INCREMENT = "increment";

	/** Имя параметра для настройки <i>showResult</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_SHOW_RESULT = "showResult";

	/** Имя параметра для настройки <i>start</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_START = "start";

	public static final String DEFAULT_NAME = "counter";
	private static final int DEFAULT_INCREMENT = 1;
	private static final boolean DEFAULT_SHOW_RESULT = true;

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String execute(WikiContext context, Map<String, String> params) throws PluginException {
		// Сначала определить, какое имя будет использоваться для хранения в WikiContext.
		String countername = params.get(PARAM_NAME);
		countername = (countername == null) ? DEFAULT_NAME : DEFAULT_NAME + "-" + countername;

		// Получить старое значение.
		Integer val = context.getVariable(countername);
		if (val == null) {
			val = 0;
		}

		// Проверить, нужно ли сбросить его.
		String start = params.get(PARAM_START);
		if (start != null) {
			val = Integer.parseInt(start);
		} else {
			// Выяснить значение приращения.
			String incrementObj = params.get(PARAM_INCREMENT);
			int increment = DEFAULT_INCREMENT;
			if (incrementObj != null) {
				increment = Integer.parseInt(incrementObj);
			}

			val = val + increment;
		}

		context.setVariable(countername, val);

		// проверить, надо ли скрыть результат. (просто посчитаем, и не покажем результат на странице)
		String showObj = params.get(PARAM_SHOW_RESULT);
		Boolean value = BooleanUtils.toBooleanObject(showObj);
		boolean show = (value != null) ? value : DEFAULT_SHOW_RESULT;

		if (show) {
			return val.toString();
		}

		return "";
	}

}
